API Gateway forward headers
When you call an API that is behind an API Gateway, the API Gateway automatically adds or passes forward headers with specific values to the API proxy or API component on your Runtime.
While Gateway forward headers are not case-sensitive, dynamic document properties are case-sensitive and require the request headers to match exactly.
Because of this, we recommend that you add the com.boomi.container.sharedServer.http.header.includelowercase container property set to true and only use lowercase document properties to avoid issues with case sensitivity. Refer to this article for additional details.
The following forward headers are sent upon request by the API:
X-Forwarded-Authorization The authorization specified is set for the request. Without this forward header, the API Gateway uses its own configured authorization setting.
X-Forwarded-Context The API Gateway's view of the context path of the request. It starts after the host name and port number and continues to the end of the path defined in the environment and API, or the path override.
X-Forwarded-For The API Gateway appends the complete list of clients that made the request to the header, separated by commas (,).
X-Forwarded-Host The host name and port number of the API Gateway. For example, api.company.com:8080. This value is only set if it is not part of the initial request.
X-Forwarded-Port The API Gateway's port number. This value is only set if it is not part of the initial request.
X-Forwarded-Proto The scheme of the request, http or https. This value is only set if it is not part of the initial request.
X-Real-Ip The requesting client IP address, as defined by the request to the API Gateway. In many cases, this is a remapped IP address through network address translation (NAT).
X-Request-URI The full path of the entire request.
